Generic Template-Driven Data Groups

Some Amocams 700 EIE data groups use generic messages, commands, and scans. These data groups use standard message formats with opcodes, data items, and offsets supplied in the device template file.

GenMsg

Data groups that have the data group attribute msgType="GenMsg" are implemented using a generic message along with attribution from the device template file. Data groups using msgType="GenMsg" are ordinalized. The request includes two bytes: a data byte count of 1 and a data value of the data group ordinal.

GenMsg (read)

Attribute Description Required

cmdCodeRecv

Command code

Yes

dataLength

Number of bytes in response

Yes

returnsDataLength

True if response includes data length.

Default: false

No

returnsResultCode

True if response includes a result code.

Default: true

No

GenMsg (write)

Attribute Description Required

cmdCodeSend

Command code

Yes

dataLength

Number of bytes in request

Yes

incUserId

True if user ID is included on request for a data group send.

Default: false

No

byteCntOffSend

Increase to data length in request for a data group send Default: 0

No

returnsDataLength

True if response includes data length.

Default: false

No

returnsResultCode

True if response includes a result code.

Default: true

No

Examples

<EGMPlus baseOrd="1" niceName="EGM Parameters Plus" maxCnt="4" forceSave="true" ordLabel="Run#" canSend="true" uccSend="true" uccRecv="true" msgType="GenMsg" cmdCodeRecv="0xC6" cmdCodeSend="0xC5" dataLength="88" incUserId="true" byteCntOffSend="15">

 

<SwabCtrl baseOrd="5" niceName="Swab Control" maxCnt="1" forceSave="false" msgType="GenMsg" cmdCodeSend="0x90" cmdCodeRecv="0x91" dataLength="2" canSend="true" uccSend="true">

GenScan

Data groups that have data group attribute msgType="GenScan" are implemented using a generic message along with attribution from the device template file. These data groups are read-only.

GenScan

Attribute Description Required

cmdCodeRecv

Command code

Yes

returnsDataLength

True if response includes data length on data group read.

Default: false

No

returnsResultCode

True if response includes a result code.

Default: true

No

Examples

This is an example of the Scan21 data group implemented generically as a GenScan message.

<Scan21G niceName="Scan 21 Generic Scan" msgType="GenScan" cmdCodeRecv="0x21" dataLength="70">

GenCmd

The data group attribute msgType="GenCmd" is implemented in a write-only data group. The msg data includes two bytes: length = 1 (1 byte) and ordinal (1 byte).

GenScan

Attribute Description Required

cmdCodeSend

Command code

Yes

dataLength

Number of bytes in response

Yes

returnsResultCode

True if response includes a result code.

Default: true

No

responseExpected

Default: true

No

Back to top